Repository navigation
Give the README and package READMEs the shared nullean shape - #45
Merged
Merged
Conversation
The root README gets the org lockup, a tagline, one badge row, the real release notes the tool generates for elastic/apm-agent-dotnet 1.11.0, install, quick start with the commands and shared options, the GitHub Action and container usage, the upgrade notes, a packages table and links. The package README, packed into the root, any and per-RID packages, follows the package template and stays nuget.org-safe. Corrects the upgrade note: the Argh CLI shipped in 0.11.0, not 1.0.0. Adds what --format asciidoc does: --output becomes a directory and nothing is printed to standard out. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the root README and the package README in line with the shared nullean templates (
standards/README.template.md,standards/PACKAGE-README.template.md, rollout section 6).Prompt summary: root and package READMEs share common branding and structure; package READMEs are valid for nuget.org; images where they show something off.
What
release-notes generate elastic apm-agent-dotnet --version 1.11.0, a public repository that still labels its pull requestsvX.Y.Z. After it come install, a quick start with the commands (realfind-previous/current-versionoutput), the shared options, the GitHub Action and container usage, upgrade notes, a packages table (root, per-RID,any) and links.src/release-notes/README.md, packed into the root,anyand per-RID packages): follows the package template. It is CommonMark only, with absolute links and the PNG lockup from raw.githubusercontent.com. The quick start is the same real output.1.0.0. It shipped in0.11.0(git tag --contains e93d1a4), and nuget.org is at 0.11.5.--format asciidocprints nothing to standard out.--outputbecomes a directory with the generated, human, per-version and index.asciidocfiles (WriteAsciiDocReleaseNotes).create-releaseis an upsert (CreateOrUpdateRelease).Verify
Run locally rather than on CI.
mise run packproduced the root andanypackages.dotnet pack -r osx-arm64produced a per-RID package the same way CI'saot-packjob does. All three carry a README byte-identical tosrc/release-notes/README.md.mise run checkpasses (curb: no drift; zizmor: no findings).🤖 Generated with Claude Code